[docs] clarify headers in development.md #4048
Conversation
… by blank lines - enforced by markdown linter
|
@marbre @ScottTodd Wanting to make it easier for you to accept the changes you do like, so I've taken the first two tiny commits from #3932 and put them into their own PR as is! Hopefully that'll move along the overall doc refresh and prevent this stack of PRs from going stale. How's this one look? |
| 1. Launch an interactive docker container with the required deps installed: | ||
|
|
||
| ```shell | ||
| ./utils/bazel/docker/run_docker.sh | ||
| ``` |
There was a problem hiding this comment.
Thanks for adding the newline before the code block.
You should also indent these code blocks so they appear nested under the list items:
| 1. Launch an interactive docker container with the required deps installed: | |
| ```shell | |
| ./utils/bazel/docker/run_docker.sh | |
| ``` | |
| 1. Launch an interactive docker container with the required deps installed: | |
| ```shell | |
| ./utils/bazel/docker/run_docker.sh | |
| ``` |
First here is with the indentation, second is without:
| # Checkout and build from source | ||
| # Environment |
There was a problem hiding this comment.
I would keep the title descriptive and not rely on the source file name/path to provide that context.
How about "Building from source" or "Development guide"? Then the first subsection can be "Environment setup" or "Prerequisites"
You can use
Document Title
==============
as the title if you want to use multiple <h1> headings throughout the document. I usually only have a single # (<h1>) on my pages and treat that as the title, with all other subsections starting at ## (<h2>), but that's a preference.
No description provided.